home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3dm / old-compression / clQueryParams.z / clQueryParams
Encoding:
Text File  |  1998-10-20  |  5.5 KB  |  133 lines
  1.  
  2.  
  3.  
  4. ccccllllQQQQuuuueeeerrrryyyyPPPPaaaarrrraaaammmmssss((((3333ddddmmmm))))                                          ccccllllQQQQuuuueeeerrrryyyyPPPPaaaarrrraaaammmmssss((((3333ddddmmmm))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      clQueryParams, clGetParamID - Get a list of the parameters for a
  10.      specified processing object, or the parameter identifier given the name
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      ####iiiinnnncccclllluuuuddddeeee <<<<ddddmmmmeeeeddddiiiiaaaa////ccccllll....hhhh>>>>
  14.  
  15.      iiiinnnntttt ccccllllQQQQuuuueeeerrrryyyyPPPPaaaarrrraaaammmmssss((((CCCCLLLLhhhhaaaannnnddddlllleeee hhhhaaaannnnddddlllleeee,,,,
  16.          iiiinnnntttt ****ppppaaaarrrraaaammmmVVVVaaaalllluuuueeeeBBBBuuuuffffffffeeeerrrr,,,, iiiinnnntttt bbbbuuuuffffffffeeeerrrrLLLLeeeennnnggggtttthhhh))))
  17.      iiiinnnntttt ccccllllGGGGeeeettttPPPPaaaarrrraaaammmmIIIIDDDD((((CCCCLLLLhhhhaaaannnnddddlllleeee hhhhaaaannnnddddlllleeee,,,, cccchhhhaaaarrrr ****ppppaaaarrrraaaammmmNNNNaaaammmmeeee))))
  18.  
  19. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  20.      _h_a_n_d_l_e         A handle to a compressor or decompressor.
  21.  
  22.      _p_a_r_a_m_V_a_l_u_e_B_u_f_f_e_r
  23.                     An array of ints into which ccccllllQQQQuuuueeeerrrryyyyPPPPaaaarrrraaaammmmssss writes name/type
  24.                     pairs.
  25.  
  26.      _b_u_f_f_e_r_L_e_n_g_t_h   The number of ints in _b_u_f_f_e_r.
  27.  
  28.      _p_a_r_a_m_N_a_m_e      The parameter name.
  29.  
  30.  
  31. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  32.      ccccllllQQQQuuuueeeerrrryyyyPPPPaaaarrrraaaammmmssss gets a list of parameters for the specified compressor or
  33.      decompressor.  Name/type pairs are written into _b_u_f_f_e_r up to the capacity
  34.      _b_u_f_f_e_r_L_e_n_g_t_h.  The even entries receive the parameter names, and the odd
  35.      entries receive the types.  The type is one of
  36.  
  37.         CCCCLLLL____EEEENNNNUUUUMMMM____VVVVAAAALLLLUUUUEEEE           only certain constant values are valid
  38.         CCCCLLLL____RRRRAAAANNNNGGGGEEEE____VVVVAAAALLLLUUUUEEEE          any value in a given range is valid
  39.         CCCCLLLL____FFFFLLLLOOOOAAAATTTTIIIINNNNGGGG____EEEENNNNUUUUMMMM____VVVVAAAALLLLUUUUEEEE  only certain constant floating point values
  40.                                 are valid
  41.         CCCCLLLL____FFFFLLLLOOOOAAAATTTTIIIINNNNGGGG____RRRRAAAANNNNGGGGEEEE____VVVVAAAALLLLUUUUEEEE any value in a given floating point range
  42.                                 is valid
  43.  
  44.      ccccllllGGGGeeeettttPPPPaaaarrrraaaammmmIIIIDDDD is used to obtain the parameter identifier given a parameter
  45.      name.  The identifier is needed for other calls such as ccccllllGGGGeeeettttPPPPaaaarrrraaaammmmssss and
  46.      ccccllllSSSSeeeettttPPPPaaaarrrraaaammmmssss.
  47.  
  48.      See CLintro(3dm) for a discussion of the general parameters common to all
  49.      algorithms.
  50.  
  51.  
  52. RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEESSSS
  53.      ccccllllQQQQuuuueeeerrrryyyyPPPPaaaarrrraaaammmmssss returns the size of the buffer, in number of ints, needed
  54.      to hold all of the parameters for _h_a_n_d_l_e.  (If _b_u_f_f_e_r_L_e_n_g_t_h is smaller
  55.      than this value, a partial list of parameters is filled in.)  On failure,
  56.      a negative error code is returned.
  57.  
  58.      ccccllllGGGGeeeettttPPPPaaaarrrraaaammmmIIIIDDDD returns the parameter identifier, or a negative error code.
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. ccccllllQQQQuuuueeeerrrryyyyPPPPaaaarrrraaaammmmssss((((3333ddddmmmm))))                                          ccccllllQQQQuuuueeeerrrryyyyPPPPaaaarrrraaaammmmssss((((3333ddddmmmm))))
  71.  
  72.  
  73.  
  74. EEEEXXXXAAAAMMMMPPPPLLLLEEEE
  75.           #include <dmedia/cl.h>
  76.  
  77.           int *buffer, bufferLength;
  78.           CLhandle handle;
  79.            ...
  80.           /* Find all the parameters for a processing object */
  81.           bufferLength = clQueryParams(handle, NULL, 0);
  82.           buffer = (int *) malloc(bufferLength * sizeof(int));
  83.           clQueryParams(handle, buffer, bufferLength);
  84.            ...
  85.           clGetParamID(handle, "Image width");
  86.  
  87.  
  88. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  89.      CLintro(3dm), clGetParams(3dm), clSetParams(3dm), clGetDefault(3dm),
  90.      clGetMinMax(3dm), clGetName(3dm), clAddParam(3dm)
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.